Appliance Recovery Backup Schedules CreateSpec

Appliance Recovery Backup Schedules CreateSpec

The Appliance Recovery Backup Schedules CreateSpec schema contains fields to be specified for creating a new schedule. The structure includes parts, location information, encryption password and enable flag.

This schema was added in vSphere API 6.7.

JSON Example

{
    "parts": [
        "string"
    ],
    "backup_password": "string",
    "location": "string",
    "location_user": "string",
    "location_password": "string",
    "enable": false,
    "recurrence_info": {
        "minute": 0,
        "hour": 0,
        "days": [
            "string"
        ]
    },
    "retention_info": {
        "max_count": 0
    },
    "fast_backup": false
}

array of string

parts

Optional

List of optional parts to be backed up. Use the GET /appliance/recovery/backup/parts operation to get information about the supported parts.

This property was added in vSphere API 6.7.

If missing or null all the optional parts will not be backed up.

string As password As password

backup_password

Optional

Password for a backup piece. The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space).

This property was added in vSphere API 6.7.

If missing or null the backup piece will not be encrypted.

string As uri As uri

location

Required

URL of the backup location.

This property was added in vSphere API 6.7.

string

location_user

Optional

Username for the given location.

This property was added in vSphere API 6.7.

If missing or null authentication will not be used for the specified location.

string As password As password

location_password

Optional

Password for the given location.

This property was added in vSphere API 6.7.

If missing or null authentication will not be used for the specified location.

boolean

enable

Optional

Enable or disable a schedule.

This property was added in vSphere API 6.7.

If missing or null the schedule will be enabled.

recurrence_info

Optional

Recurrence information for the schedule.

This property was added in vSphere API 6.7.

If missing or null backup job will not be scheduled. See Appliance Recovery Backup Schedules RecurrenceInfo

retention_info

Optional

Retention information for the schedule.

This property was added in vSphere API 6.7.

If missing or null all the completed backup jobs will be retained forever. See Appliance Recovery Backup Schedules RetentionInfo

boolean

fast_backup

Optional

Option to enable Postgres DB/ VCDB fast backup

This property was added in vSphere API 6.7.

If missing or null backup will proceed at slow rate